Skip to content

Conversation

@rStelmach
Copy link
Contributor

@rStelmach rStelmach commented May 27, 2025

Added a tooltip and a link with documentation for Failed docs column when dataset does not have failure store enabled.

failed_docs_tooltip.mov

For now it awaits for the documentation PR to be merged : elastic/docs-content#1368

@rStelmach rStelmach changed the title 221006 dataset quality indicate if failure store isnt enabled for data stram [Dataset Quality] Indicate if failure store isn't enabled for data stream May 28, 2025
@rStelmach rStelmach added 9.1 candidate v8.19.0 v9.1.0 release_note:feature Makes this part of the condensed release notes backport:version Backport to applied version labels Feature:Dataset Health and removed 9.1 candidate labels May 28, 2025
@rStelmach rStelmach marked this pull request as ready for review May 28, 2025 15:53
@rStelmach rStelmach requested a review from a team as a code owner May 28, 2025 15:53
@yngrdyn
Copy link
Contributor

yngrdyn commented May 29, 2025

/oblt-deploy

@yngrdyn yngrdyn self-requested a review May 29, 2025 10:59
Copy link
Contributor

@yngrdyn yngrdyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this one @rStelmach.
I have two main comments here:

  1. I think we should change the approach here, from your changes I can infer that we are treating privileges (meaning user can not read failure store: read_failure_store) the same as a failure store not enabled for an specific dataStream. Take the following as an example (You can find everything configured in the PR deployment):

I've set up a custom component template enabling failure store for data streams following the pattern logs-foo-*

script
PUT _component_template/logs-foo@custom
{
  "template": {
    "data_stream_options": {
      "failure_store": {
        "enabled": true
      }
    }
  }
}
image

Then I ingested some documents in logs-foo-1 (Failure store enabled) and logs-bar-1 (Failure store disabled)

script
### Failure store enabled
POST logs-foo-1/_doc/1?op_type=create
{
  "foo": "bar"
}
POST logs-foo-1/_doc/2?op_type=create
{
  "foo": { "bar": 123}
}

#### Failure Store not enabled
POST logs-bar-1/_doc/1?op_type=create
{
  "foo": "bar"
}
POST logs-bar-1/_doc/2?op_type=create
{
  "foo": { "bar": 123}
}

User has proper privileges to read failure store over all datastreams following logs-* pattern

image

And this is what I see in dataset quality page
image

This is what I should be seeing
image

but I can only get to that state if the user doesn't have read privileges over failure store.

  1. We should also consider what to do inside a specific dataStream in regards to failure Store, should we show something there (?) or instead we could use a banner at the top with a link to the specific documentation? (Something similar to what we do when user doesn't have privileges but now for enabling the failure store for the specific datastream)
image

@LucaWintergerst, @patpscal what are your thoughts on this one?

Note

I configured everything in the PR deployment, you can access with elastic, failure_store_some_enabled and failure_store_some_restricted with the same password generated by oblt-deploy command (🔒 deployment)

@rStelmach rStelmach requested a review from yngrdyn June 9, 2025 10:58
@yngrdyn
Copy link
Contributor

yngrdyn commented Jun 11, 2025

We are missing some api tests (integration) asserting that we are getting the right information regarding failureStore being enabled/disabled

@LucaWintergerst
Copy link
Contributor

@yngrdyn apologies for the super slow reply here - this is good, thank you work implementing it like this

@patpascal
Copy link
Contributor

@patpscal is it ok to show the enablement as a warning? Should we treat it as an info instead?

I think we could treat that either way!

? i18n.translate('xpack.datasetQuality.failureStore.enable', {
defaultMessage: 'Set failure store',
})
: 'N/A'}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should also be translated

@yngrdyn
Copy link
Contributor

yngrdyn commented Jun 23, 2025

/oblt-deploy

@yngrdyn yngrdyn self-requested a review June 23, 2025 06:01
css={{ textDecoration: 'underline' }}
>
{i18n.translate('xpack.datasetQuality.enableFailureStore', {
defaultMessage: 'Enable failure store',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this to look more like a link?
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding an icon would be beneficial here @patpscal?

Copy link
Contributor Author

@rStelmach rStelmach Jun 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2025-06-23 at 11 29 05

How about this ?

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
datasetQuality 418.5KB 420.3KB +1.7KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
datasetQuality 23.8KB 24.1KB +253.0B

History

Copy link
Contributor

@yngrdyn yngrdyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for taking this one
Good job 🚀

@rStelmach rStelmach merged commit 36cbbb9 into elastic:main Jun 24, 2025
10 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.19

https://github.com/elastic/kibana/actions/runs/15844551689

kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 24, 2025
…ream (elastic#221644)

Added a tooltip and a link with documentation for Failed docs column
when dataset does not have failure store enabled.

https://github.com/user-attachments/assets/be65db9a-15c8-4087-b175-752b2fabab6e

For now it awaits for the documentation PR to be merged :
elastic/docs-content#1368

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Yngrid Coello <[email protected]>
(cherry picked from commit 36cbbb9)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.19

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Jun 24, 2025
…data stream (#221644) (#225007)

# Backport

This will backport the following commits from `main` to `8.19`:
- [[Dataset Quality] Indicate if failure store isn't enabled for data
stream (#221644)](#221644)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Robert
Stelmach","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-06-24T07:49:36Z","message":"[Dataset
Quality] Indicate if failure store isn't enabled for data stream
(#221644)\n\nAdded a tooltip and a link with documentation for Failed
docs column\nwhen dataset does not have failure store
enabled.\n\n\n\nhttps://github.com/user-attachments/assets/be65db9a-15c8-4087-b175-752b2fabab6e\n\n\n\n\nFor
now it awaits for the documentation PR to be merged
:\nhttps://github.com/elastic/docs-content/pull/1368\n\n---------\n\nCo-authored-by:
kibanamachine
<[email protected]>\nCo-authored-by:
Yngrid Coello
<[email protected]>","sha":"36cbbb9bf8f141a54bb6c455e4479e93990d9626","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:feature","Feature:Dataset
Health","backport:version","v9.1.0","v8.19.0"],"title":"[Dataset
Quality] Indicate if failure store isn't enabled for data
stream","number":221644,"url":"https://github.com/elastic/kibana/pull/221644","mergeCommit":{"message":"[Dataset
Quality] Indicate if failure store isn't enabled for data stream
(#221644)\n\nAdded a tooltip and a link with documentation for Failed
docs column\nwhen dataset does not have failure store
enabled.\n\n\n\nhttps://github.com/user-attachments/assets/be65db9a-15c8-4087-b175-752b2fabab6e\n\n\n\n\nFor
now it awaits for the documentation PR to be merged
:\nhttps://github.com/elastic/docs-content/pull/1368\n\n---------\n\nCo-authored-by:
kibanamachine
<[email protected]>\nCo-authored-by:
Yngrid Coello
<[email protected]>","sha":"36cbbb9bf8f141a54bb6c455e4479e93990d9626"}},"sourceBranch":"main","suggestedTargetBranches":["8.19"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/221644","number":221644,"mergeCommit":{"message":"[Dataset
Quality] Indicate if failure store isn't enabled for data stream
(#221644)\n\nAdded a tooltip and a link with documentation for Failed
docs column\nwhen dataset does not have failure store
enabled.\n\n\n\nhttps://github.com/user-attachments/assets/be65db9a-15c8-4087-b175-752b2fabab6e\n\n\n\n\nFor
now it awaits for the documentation PR to be merged
:\nhttps://github.com/elastic/docs-content/pull/1368\n\n---------\n\nCo-authored-by:
kibanamachine
<[email protected]>\nCo-authored-by:
Yngrid Coello
<[email protected]>","sha":"36cbbb9bf8f141a54bb6c455e4479e93990d9626"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Robert Stelmach <[email protected]>
Co-authored-by: Yngrid Coello <[email protected]>
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request Jun 25, 2025
…ream (elastic#221644)

Added a tooltip and a link with documentation for Failed docs column
when dataset does not have failure store enabled.



https://github.com/user-attachments/assets/be65db9a-15c8-4087-b175-752b2fabab6e




For now it awaits for the documentation PR to be merged :
elastic/docs-content#1368

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Yngrid Coello <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:version Backport to applied version labels Feature:Dataset Health release_note:feature Makes this part of the condensed release notes v8.19.0 v9.1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants